feat: add data_uses to datasets, deprecate data_purposes#40
Open
galvana wants to merge 1 commit into
Open
Conversation
Add a `data_uses` field to Dataset, DatasetCollection, and DatasetField alongside the now-deprecated `data_purposes`. A model validator mirrors the two so a dataset always carries both, letting readers on either name resolve during the rename (expand/contract). `data_purposes` will be removed in a later release once readers have migrated. Co-Authored-By: Claude Opus 4.8 <[email protected]>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Adds a
data_usesfield toDataset,DatasetCollection, andDatasetField, alongside the now-deprecateddata_purposes. A model validator mirrors the two so a dataset always carries both.Why
data_purposes(added in #39, released in 3.1.x) is being renamed todata_usesto match Fides taxonomy naming (data_use). Becausedata_purposesis already released and persisted (collection/field-level lives in datasetcollectionsJSON), a straight rename would break backward compatibility. This uses the expand/contract (parallel change) pattern:data_uses, keepdata_purposes(deprecated), mirror both via a validator (dual-write). Readers on either name resolve.data_uses, stop writingdata_purposes, then remove it.Downstream
fidesplus consumes this: it dual-reads both keys and will bump its
fideslangpin to the release that includes this change. See the paired fidesplus PR.🤖 Generated with Claude Code